chore: command orchestration #5791

TarunAdobe · 2025-10-07T09:24:13Z

Description

Added build-, test-, start-, and lint- root scripts so first- and second-gen workspaces can be orchestrated together.
Introduced a prebuild wireit target in first-gen/package.json that triggers the second-gen core build before the existing build pipeline.
Renamed the second-gen workspace to @adobe/swc and updated yarn.lock to reflect the new package name.

Motivation and context

Make the root package the single entry point for common dev workflows that span both generations of Spectrum Web Components.
Ensure first-gen builds automatically compile second-gen core artifacts to keep shared output in sync.

Related issue(s)

fixes [Issue Number]

Screenshots (if appropriate)

Author's checklist

I have read the CONTRIBUTING and PULL_REQUESTS documents.
I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
I have added automated tests to cover my changes.
I have included a well-written changeset if my change needs to be published.
I have included updated documentation if my change required it.

Reviewer's checklist

Includes a Github Issue with appropriate flag or Jira ticket number without a link
Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
Automated tests cover all use cases and follow best practices for writing
Validated on all supported browsers
All VRTs are approved before the author can update Golden Hash

Manual review test cases

Build Pipeline (First-gen and Second-gen)
- Test: Run yarn build at the repo root.
- Goal: Ensure both first-gen and second-gen workspaces build successfully and in the correct order.
- Check: No errors in the build output. Artifacts for both generations are correctly produced.
Test Scripts
- Test: Run yarn test, yarn test-first-gen, and yarn test-second-gen at the root.
- Goal: All tests in both generations (unit, integration, etc.) must pass.
- Check: Look for failures in either workspace.
Linting
- Test: Run yarn lint, yarn lint-first-gen, and yarn lint-second-gen.
- Goal: Linting completes without errors for both codebases.
- Check: Confirm the new shared ESLint config is applied and that there are no unexpected warnings or errors.
Wireit Integration
- Test: Run yarn workspace @adobe/spectrum-web-components build (or the specific first-gen build command).
- Goal: The new prebuild Wireit script should reliably trigger the second-gen build as a dependency.
- Check: No race conditions or missed dependencies; confirm that changes in second-gen core trigger rebuilds as expected.
CI/CD
- Test: Monitor all automated build and test jobs in your CI (e.g., GitHub Actions, Jenkins).
- Goal: All jobs pass after merging these changes.
- Check: Especially watch for any failures in composite builds or jobs that run the changed scripts.

Device review

Did it pass in Desktop?
Did it pass in (emulated) Mobile?
Did it pass in (emulated) iPad?

changeset-bot · 2025-10-07T09:24:17Z

⚠️ No Changeset found

Latest commit: 1f1e69e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2025-10-07T09:26:27Z

📚 Branch Preview

🔍 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5791

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

github-actions · 2025-10-07T09:29:55Z

Tachometer results

Currently, no packages are changed by this PR...

rubencarvalho · 2025-10-14T10:51:21Z

first-gen/package.json

Would start also require yarn run dev on core?

rubencarvalho · 2025-10-14T10:51:59Z

second-gen/package.json

+        "clean": "yarn workspaces foreach --from '@swc/*' --recursive run clean",
        "lint": "eslint . --ext .ts,.js,.json",
-        "storybook": "yarn workspace @swc/components storybook",
+        "start": "yarn workspace @swc/components storybook",


Same here, wouldn't this also depend on core running in dev mode?

yarn start needs yarn build and yarn build will build the core as well as the second-gen/first-gen depending on what is required and that's enough to run the storybook

Yes, but without core running with HMR, it means changes made to any core file won't be hot-reloaded in Storybook.

We may also want to get the CEM analyzer to run in --watch mode, because we will want getStorybookHelpers to automatically reflect the changes to the component.

Rajdeepc · 2025-10-15T13:18:51Z

second-gen/package.json

    "scripts": {
-        "build": "yarn workspaces foreach --from '@swc/*' run build",
-        "clean": "yarn workspaces foreach --from '@swc/*' run clean",
+        "build": "yarn workspaces foreach --from '@swc/*' --recursive run build",


This will force Yarn to traverse downstream dependents, rebuilding or cleaning even when nothing changed. Is this what we need? We can do caching or parallelisation here too. Let me know your setup

Rajdeepc · 2025-10-15T13:19:38Z

second-gen/package.json

-        "build": "yarn workspaces foreach --from '@swc/*' run build",
-        "clean": "yarn workspaces foreach --from '@swc/*' run clean",
+        "build": "yarn workspaces foreach --from '@swc/*' --recursive run build",
+        "clean": "yarn workspaces foreach --from '@swc/*' --recursive run clean",


If you just want to delete the SWC output you can avoid the cascading clean. You can just run this?

yarn workspaces foreach --from '@swc/*' run clean

marissahuysentruyt · 2025-10-15T13:37:08Z

package.json

+        "build-first-gen": "yarn workspace @adobe/spectrum-web-components build",
+        "build-second-gen": "yarn workspace @adobe/swc build",
+        "build": "yarn build-first-gen && yarn build-second-gen",


This is strictly a curiosity I had: can you explain why you chose build-first-gen over something like build:first-gen? I've just seen the colon syntax more often, that's all.

Sort of along these lines, if we went with the colon syntax instead, could we do something like:

"build": "yarn build:*",

Why does the order of building first-gen or second-gen matter? I honestly don't know what order something like yarn build:* would build each project, so maybe this is not even a good idea or feasible! 😆

For the first part, It was an oversight on my end. I feel its better to use build:first-gen and so I switched that up. And about the second one, no the order of building first-gen or second-gen doesn't matter as long as both are being built before starting their respective storybooks.

marissahuysentruyt · 2025-10-15T18:42:35Z

Just wanted to leave some notes as I was walking through the validation steps.

For yarn build:
I am getting build errors (for second-gen), but they're not enough for me not to run either project. Were you getting those at all? 🤔 Maybe they're known or acceptable errors for now.

For yarn test:

the new first-gen and second-gen commands work from the root, and yarn test fires off both with no problems. 🥳

WireIt and workspace commands
First-gen and second-gen can be run with their corresponding Storybook start commands. 👍

For yarn lint:
For second-gen, I get the eslint command is not found error. First-gen I think is working- it output where I made changes correctly (to be honest, I don't remember what the output typically looks like for linting on main)

I don't think this is related to this PR or not, but when I run yarn build from the root (after running nvm use && git clean -dfX && yarn), I do get a message that Vite requires nvm version 20.19+, but our .nvmrc only has nvm at 20.13.1. Is that something we would want to address at some point?

…from next-gen

chore: hoist dev commands to root packagejson

3cd08a9

TarunAdobe changed the title ~~chore: hoist dev commands to root packagejson~~ chore: command orchestration Oct 7, 2025

TarunAdobe marked this pull request as ready for review October 8, 2025 05:54

TarunAdobe requested a review from a team as a code owner October 8, 2025 05:54

TarunAdobe self-assigned this Oct 8, 2025

TarunAdobe requested a review from rubencarvalho October 8, 2025 05:54

chore: add a root level eslint config file

ffa43cc

rubencarvalho reviewed Oct 14, 2025

View reviewed changes

first-gen/package.json

Copy link

Contributor

rubencarvalho Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would start also require yarn run dev on core?

rubencarvalho reviewed Oct 14, 2025

View reviewed changes

Rajdeepc reviewed Oct 15, 2025

View reviewed changes

marissahuysentruyt reviewed Oct 15, 2025

View reviewed changes

TarunAdobe added 2 commits October 16, 2025 14:32

fix(progress-circle): remove @spectrum-web-component/base dependency …

1e00ab5

…from next-gen

chore: update build commands in root packagejson

1f1e69e

chore: command orchestration #5791

Are you sure you want to change the base?

chore: command orchestration #5791

Conversation

TarunAdobe commented Oct 7, 2025 • edited by Rajdeepc Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and context

Related issue(s)

Screenshots (if appropriate)

Author's checklist

Reviewer's checklist

Manual review test cases

Device review

Uh oh!

changeset-bot bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Branch Preview

🔍 Visual Regression Test Results

Uh oh!

github-actions bot commented Oct 7, 2025

Tachometer results

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt commented Oct 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

TarunAdobe commented Oct 7, 2025 •

edited by Rajdeepc

Loading

changeset-bot bot commented Oct 7, 2025 •

edited

Loading

github-actions bot commented Oct 7, 2025 •

edited

Loading

marissahuysentruyt Oct 15, 2025 •

edited

Loading